************
Introduction
************

The :mod:`gslab_make` Python library contains tools to facilitate workflow automation for research projects. It is designed to help researchers implement the following rules of `Code and Data for the Social Sciences: A Practioner's Guide <https://web.stanford.edu/~gentzkow/research/CodeAndData.pdf>`__.

.. code-block:: md

    Automation
    (A) Automate everything that can be automated.
    (B) Write a single script that executes all code from beginning to end.

    Directories
    (A) Separate directories by function.
    (B) Separate files into inputs and outputs.
    (C) Make directories portable.

The library is currently under active development. If you wish to contribute, please visit the `Github repository <https://github.com/gentzkow/gslab_make>`__.


.. toctree::
  :maxdepth: 2
  :caption: Documentation

  pages/specifying_paths
  pages/general_logging
  pages/sourcing
  pages/source_logging
  pages/program
  pages/utility
  pages/repository
  pages/directory
  pages/filling